Snapservice ProtectionGroupInfo
The Snapservice ProtectionGroupInfo schema contains properties that provide detailed information regarding the protection group and the snapshot policies associated with it.
This schema was added in vSphere API 8.0.3.0.
{
"name": "string",
"status": "string",
"target_entities": {
"vm_name_patterns": [
"string"
],
"vms": [
"string"
],
"tag_rules": [
{
"tags": [
"string"
],
"operator": "string"
}
]
},
"snapshot_policies": [
{
"name": "string",
"schedule": {
"unit": "string",
"interval": 0
},
"retention": {
"unit": "string",
"duration": 0
}
}
],
"last_snapshot_time": "string",
"oldest_snapshot_time": "string",
"vms": [
"string"
],
"snapshots": [
"string"
],
"locked": false,
"guid": "string",
"replication_policies": [
{
"cluster_pair": "string",
"recovery_point_objective": {
"unit": "string",
"duration": 0
},
"snapshot_retention": {
"short_term": {
"keep_last": 0
},
"long_term": {
"hourly": {
"retention": {
"unit": "string",
"duration": 0
}
},
"daily": {
"hour": 0,
"retention": {
"unit": "string",
"duration": 0
}
},
"weekly": {
"hour": 0,
"day_of_week": "string",
"retention": {
"unit": "string",
"duration": 0
}
},
"monthly": {
"hour": 0,
"day_of_month": 0,
"retention": {
"unit": "string",
"duration": 0
}
}
}
},
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
},
"target_entity_replication_spec": {
"vm_replication_specs": [
{
"vm": "string",
"config_params": {
"target_config": {
"use_replica_seed": false,
"storage_spec": {
"target_datastore": "string"
}
}
}
}
]
}
}
]
}Name of the protection group.
This property was added in vSphere API 8.0.3.0.
Current status of the protection group.
For more information see: Snapservice ProtectionGroupStatus.
This property was added in vSphere API 8.0.3.0.
User provided target entities that must belong to the protection group.
This property was added in vSphere API 8.0.3.0.
Snapshot policies for the protection targets.
This property was added in vSphere API 8.0.3.0.
Time at which the last protection group snapshot was taken.
This property was added in vSphere API 8.0.3.0.
is missing or null if there are no snapshots taken for the protection group.
Time at which the current oldest protection group snapshot was taken.
This property was added in vSphere API 8.0.3.0.
is missing or null if there are no snapshots taken for the protection group.
List of virtual machines that belong to the protection group. This is a combined list of virtual machines from the dynamic vm name and the individual list of virtual machines specified during creation of the protection group.
This property was added in vSphere API 8.0.3.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: VirtualMachine.
List of snapshots taken for the protection group.
This property was added in vSphere API 8.0.3.0.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.snapservice.protection_group.snapshot.
Indicates if the protection group is to be locked. A locked protection group cannot be modified or deleted by the user. All snapshots associated with the protection group will be secure and cannot be deleted. The system will automatically delete these snapshots upon expiry based on the retention period
This property was added in vSphere API 8.0.3.0.
The Global identifier of the protection group, which can be used to associate protection groups created on remote sites as part of replication configurations
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
Replication configuration for the protection group specified by the user.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.